Skip to main content
POST
[CBFull] Run Full Competitive Brief

Authorizations

Authorization
string
header
required

Bearer token from your account (https://agent.ai/user/integrations#api)

Body

application/json
company_name
string
required

Name of your company.

role
enum<string>
default:sales
required

Your role determines which insights are prioritized.

Available options:
sales,
marketing,
product,
executive,
founder,
entrepreneur,
investor,
consultant,
business_development,
customer_success,
operations,
finance,
hr,
engineering,
other
output_variable_name
string
default:competitive_brief
required

Variable name for the competitive brief JSON.

Pattern: ^[a-zA-Z][a-zA-Z0-9_]*$
about
string

Brief description of what your company does.

use_user_context_role
boolean
default:true

Use role from your user profile settings instead of the dropdown above.

use_full_user_context
boolean
default:true

Auto-generate about, industry, and keywords from your profile data (company, title, LinkedIn, etc.) using AI.

industry
string

Your company's industry (e.g., SaaS, Healthcare, FinTech).

industry_keywords
string

Comma-separated industry keywords for better targeting.

competitors
string

List competitors in any format: 'Salesforce, HubSpot' or 'salesforce.com, hubspot.com' or JSON array. Will be auto-parsed.

brand_keywords
string

Comma-separated brand keywords to monitor mentions.

contacts
string

List contacts in any format: names, LinkedIn URLs, emails, or JSON. Will be auto-parsed.

force_refresh
boolean
default:false

Bypass cache and fetch fresh data.

email
string

Email address to send brief to (optional).

send_email
boolean
default:false

Send brief via email after generation.

Response

Successful response

status
integer<int32>

HTTP status code of the action response

response
object

Response data from the action